Socket
Socket
Sign inDemoInstall

@kronos-integration/service

Package Overview
Dependencies
Maintainers
2
Versions
309
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@kronos-integration/service

Base service implementation


Version published
Maintainers
2
Created
Source

Build Status codecov.io Commitizen friendly downloads GitHub Issues Greenkeeper Known Vulnerabilities License minified size npm semantic-release styled with prettier

kronos-service

Base service implementation

API

Table of Contents

DESCRIPTION

key of the service description

Service

Extends EndpointsMixin(StateTransitionMixin(LogLevelMixin(events), prepareActions({ start: { stopped: rsf5000 }, restart: { stopped: rsf5000, running: { target: "running", during: "restarting", timeout: 5000 } }, stop: { running: ssf5000, starting: ssf5000, failed: ssf5000 } }), "stopped"))

Service The initial state is 'stopped' All services have at least three endpoints:

  • log out: log events
  • config in: configuration request
  • command in: administrative actions to be executed by the step

Parameters

  • config Object
    • config.name string
    • config.logLevel string
    • config.autostart boolean defaults to false
    • config.description string
    • config.endpoints Object will be merged with the build in ones
  • ic InitializationContext

stateChanged

Called when the service state changes. Emits a serviceStateChanged event to the owner

Parameters

rejectWrongState

Called when state transition is not allowed

Parameters
  • action string originating action name

  • Throws any always

timeoutForTransition

Deliver transtion timeout

Parameters

Returns number milliseconds before throwing for a logn running transition

_restart

Restart action default implementation does a _stop() and a _start()

Returns Promise fulfills after start

restartIfRunning

Restarts if in running mode Otherwise does nothing

Returns Promise resolves when restart is done (or immediate if no restart triggered)

toStringAttributes

mapping of properties used in toString

Returns Object

toString

Returns the string representation of this step

Returns string human readable name

toJSONWithOptions

Deliver json representation

Parameters
  • options Object
    • options.includeRuntimeInfo boolean include runtime informtion like state
    • options.includeDefaults boolean include default endpoints
    • options.includeName boolean include name of the service
    • options.includeConfig boolean include config attributes

Returns Object json representation

name

defaults to the type

Returns string type

autostart

Should we start when beeing registered

Returns boolean false

_configure

Takes attribute values from config parameters and copies them over to the object. Copying is done according to configurationAttributes Which means we loop over all configuration attributes and then for each attribute decide if we use the default, call a setter function or simply assign the attribute value

Parameters

Returns Set of modified attributes

configure

Use new configuration. Internally calls _configure(config) as the constructor does If attribute with needsRestart are touched the restartIfRunning method will be called

Parameters

Returns Promise fillfills when config is applied

log

Adds service name to the log event

Parameters

endpointParentSeparator

Returns string separator between service name and endpoint name *

configurationAttributes

Meta information for the config attributes.

  • default optional default value of the attribute
  • needsRestart optional modification requires a service restart
  • setter(newValue,attrribute) optional function to be used if simple value assignment is not enough The Service class only defines the logLevel, ans start timeout attribute

Returns Object

endpoints

Definition of the predefined endpoints

  • log out
  • config in
  • command in

Returns Object predefined endpoints

ServiceLogger

Extends Service

Log receiving service

autostart

We always start immediate

Returns boolean true

name

Returns string 'logger'

endpoints

Adds a log input endpoint to the set of Service endpoints

Returns Object predefined endpoints

ServiceConfig

Extends Service

Config providing service Dispatches config requests to services or preserves them until a maching service becomes avaliable

Parameters

  • args ...any

Properties

  • preservedConfigs Map<string, Object> values for services not alredy established

configureValue

set config entry

Parameters
  • key string path to the value
  • value any

configure

Parameters

autostart

We always start immediate

Returns boolean true

name

Returns string 'config'

ServiceProviderMixin

Provide services and hold service configuration. By default a service provider has two build in services 'logger' and 'config'.

Parameters

  • superclass
  • serviceLoggerClass Class where the logging houtd go (optional, default ServiceLogger)
  • serviceConfigClass Class where the config comes from (optional, default ServiceConfig)

InterceptorProviderMixin

Register & provide Interceptors.

Parameters

  • superclass

EndpointsMixin

Endpoint accessor mixin Manages endpoints in a container

Parameters

  • superclass Class class to be extended

Returns Class extended class

endpoints

default set of endpoints to create

Returns Object {} empty set

StandaloneServiceProvider

Extends ServiceProviderMixin(Service)

simple service manager (for examples and testing only)

name

Returns string 'stantalone-provider'

defineServiceConsumerProperties

assign services based on a configuration

Parameters

InitializationContext

keeps track of all in flight object creations and loose ends during config initialization

Parameters

  • serviceProvider

connectEndpoint

Parameters
  • endpoint Endpoint
  • connected string
  • oldEndpoint Endpoint

addOutstandingEndpointConnection

Parameters
  • endpoint Endpoint
  • connected string

install

With npm do:

npm install kronos-service

license

BSD-2-Clause

FAQs

Package last updated on 02 Dec 2019

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc